<!--

    Copyright (c) 2005, 2018 Oracle and/or its affiliates. All rights reserved.
    Portions Copyright &#169; [2017-2020] Payara Foundation and/or affiliates.

    This program and the accompanying materials are made available under the
    terms of the Eclipse Public License v. 2.0, which is available at
    http://www.eclipse.org/legal/epl-2.0.

    This Source Code may also be made available under the following Secondary
    Licenses when the conditions for such availability set forth in the
    Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
    version 2 with the GNU Classpath Exception, which is available at
    https://www.gnu.org/software/classpath/license.html.

    SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0

-->
<!-- Portions Copyright [2019] [Payara Foundation and/or its affiliates] -->

<p><a id="task-create-clustered-instance" name="task-create-clustered-instance"></a><a id="GHCLU00045" name="GHCLU00045"></a></p>

<h4><a id="sthref67" name="sthref67"></a><a id="sthref68" name="sthref68"></a><a id="sthref69" name="sthref69"></a>To Add a Payara Server Instance to a Cluster</h4>
<a name="BEGIN" id="BEGIN"></a>
<p>Payara Server instances form the basis of an application deployment. A clustered instance is a member of a cluster. Each instance belongs to a single domain and has its own directory structure, configuration, and deployed applications. Each instance also includes the Java Platform, Enterprise Edition (Java EE) web container and Enterprise JavaBeans technology (EJB technology) container. Every new instance must contain a reference to a node that defines the host where the instance will reside.</p>

<hr>
<p><b>Note:</b></p>
<p>To create an instance on a node of type CONFIG that represents a remote host, you must use the <a href="/resource/reference/en/help/reference/create-local-instance"><code>create-local-instance</code>(1)</a> subcommand. You cannot use the Administration Console for this purpose.</p>

<hr>

<a id="sthref70" name="sthref70"></a>
<h5>Before You Begin</h5>
<p>Ensure that the following items exist:</p>
<ul>
<li>
<p>The cluster to which you are adding the instance. See <a href="task-create-cluster.html">To Create a Cluster</a> for instructions.</p>
</li>
<li>
<p>The node on which the instance is to reside. See <a href="task-createnode.html">To Create a Node</a> for instructions.</p>
</li>
</ul>
<ol>
<li>
<p>In the navigation tree, expand the Clusters node.</p>
</li>
<li>
<p>Under the expanded Clusters node, select the node for the cluster.</p>
<p>The General Information page for the cluster opens.</p>
</li>
<li>
<p>On the General Information page, click the Instances tab.</p>
<p>The Clustered Server Instances page for the cluster opens.</p>
</li>
<li>
<p>On the Clustered Server Instances page, click New.</p>
<p>The New Clustered Server Instance page opens.</p>
</li>
<li>
<p>In the Name field, type a name for the instance.</p>
<p>The name must meet the following requirements:</p>
<ul>
<li>
<p>The name may contain only ASCII characters.</p>
</li>
<li>
<p>The name must start with a letter, a number, or an underscore.</p>
</li>
<li>
<p>The name may contain only the following characters:</p>
<ul>
<li>
<p>Lowercase letters</p>
</li>
<li>
<p>Uppercase letters</p>
</li>
<li>
<p>Numbers</p>
</li>
<li>
<p>Hyphen</p>
</li>
<li>
<p>Period</p>
</li>
<li>
<p>Underscore</p>
</li>
</ul>
</li>
<li>
<p>The name must be unique in the domain and must not be the name of another Payara Server instance, a cluster, a named configuration, or a node.</p>
</li>
<li>
<p>The name must not be <code>domain</code>, <code>server</code>, or any other keyword that is reserved by Payara Server.</p>
</li>
</ul>
</li>
<li>
<p>From the Node drop-down list, select the node where the instance will reside.</p>
</li>
<li>
<p>Click OK.</p>
</li>
</ol>
<a id="sthref71" name="sthref71"></a>
<h5>See Also</h5>
<ul>
<li>
<p><a href="task-delete-clustered-instances.html">To Delete Clustered Payara Server Instances</a></p>
</li>
<li>
<p><a href="task-start-clustered-instances.html">To Start Clustered Payara Server Instances</a></p>
</li>
<li>
<p><a href="task-stop-clustered-instances.html">To Stop Clustered Payara Server Instances</a></p>
</li>
<li>
<p><a href="task-view-logs-clustered-instance.html">To View Log Files for a Clustered Payara Server Instance</a></p>
</li>
<li>
<p><a href="task-recovertransactions.html">To Recover Transactions for a Clustered Payara Server Instance</a></p>
</li>
<li>
<p><a href="task-change-clustered-instance-ports.html">To Modify the Port Numbers of a Clustered Payara Server Instance</a></p>
</li>
<li>
<p><a href="task-set-props-clustered-instance.html">To Set Instance-Only Properties for a Clustered Payara Server Instance</a></p>
</li>
<li>
<p><a href="task-mon-app-clustered-instance.html">To View Application Monitoring Data for a Clustered Payara Server Instance</a></p>
</li>
<li>
<p><a href="task-mon-server-clustered-instance.html">To View Virtual-Server Monitoring Data for a Clustered Payara Server Instance</a></p>
</li>
<li>
<p><a href="task-mon-resource-clustered-instance.html">To View Resource Monitoring Data for a Clustered Payara Server Instance</a></p>
</li>
</ul>


<small>Copyright &#169; 2005, 2017, Oracle and/or its affiliates. All rights reserved. <a href="docinfo.html">Legal Notices</a></small>
<small>Portions Copyright &#169; [2017-2020] Payara Foundation and/or affiliates.</small>
